How to Send a Query
Web UI
Use the platform UI to submit queries and view responses returned by the registered agents.
REST API
Endpoint
POST /chat/query
Request
{
"query": "Your question here"
}
Response
{
"final_answer": "...",
"plan": [],
"agent_results": {},
"decision_trail": [],
"error": null
}
Response Fields
| Response Field | What it Contains |
|---|---|
final_answer | The synthesised response returned to the user |
plan | The sub-task plan generated by the Planner |
agent_results | Individual outputs from each agent that was invoked |
decision_trail | A log of routing decisions made by the Supervisor |
error | Error message if something went wrong |
Query Processing Pipeline
1. Guardrails
2. Prompt Refiner
3. Planner
4. Supervisor
5. Agent Execution
6. Aggregator
7. Final Response
Registering Your Agent
Step 1 — Register the Agent
Endpoint
POST /agents/register
| Field | Required | Description |
|---|---|---|
agent_name | yes | Unique identifier for the agent |
display_name | yes | Human-readable name shown in the UI |
version | yes | Version string |
owner_team | yes | Name of the team responsible |
contact_email | yes | Contact email |
elaborated_description | yes | Detailed description |
endpoint_url | yes | Base URL where the agent is hosted |
auth_type | yes | Authentication method |
auth_credential | Conditional | Required if auth_type is BEARER |
Step 2 — Register the Agent's APIs
Endpoint
POST /agents/{agent_name}/apis/register
Step 3 — Verify Registration
| Endpoint | What it Returns |
|---|---|
GET /agents | List of all registered agents |
GET /agents/{agent_name}/apis | All APIs registered for a specific agent |